Add path_prefix option to lint_package for GitHub Actions annotations #845
Conversation
R/lint.R
Outdated
| @@ -259,6 +259,8 @@ lint_dir <- function(path = ".", relative_path = TRUE, ..., exclusions = list("r | |||
| #' Apply one or more linters to all of the R files in a package. | |||
| #' @param path the path to the base directory of the package, if \code{NULL}, | |||
| #' it will be searched in the parent directories of the current directory. | |||
| #' @param path_prefix a prefix to add to the path of any file found, useful for | |||
There was a problem hiding this comment.
Thanks for the feedback, I would be happy to do that if that's the direction y'all would like.
For what it's worth, when we run these in our CI, we actually run them from the subdirectory, so having path_prefix / project_dir only add on to the output of the GHA annotations is the behavior we want (of course we could change where we lint from easily, so that's not a great argument for this API). If we did keep this behavior, we might also consider naming it something like annotation_path_prefix to make it's clear it's only about annotations and not where to run the file.
There was a problem hiding this comment.
IMO this is not really related to linting per se, but more to the print.lints method for GitHub.
|
Sorry for the delay on this! Thanks for the comments. I've changed the UX here using an option (similar to what's already used in the |
README.md
Outdated
| @@ -208,6 +208,8 @@ location, namely in the `.github/workflows` directory of your repository. This f | |||
| pull request with the lints found and they will also be printed as [annotations](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-status-checks#types-of-status-checks-on-github) along side the status check on GitHub. If you want to disable the commenting you can | |||
| set the environment variable `LINTR_COMMENT_BOT=false`. | |||
|
|
|||
| If your project is in a subdirectory, and you would like to use GitHub Actions annotations, you can set `options(lintr.github_annotation_project_dir = "path/to/project")` which will add the path specified to the beginning of filenames in the annotations. | |||
There was a problem hiding this comment.
I suggest wording it like "... which will make sure the annotations point to the correct files." or something like that, to describe the intention, not the technique. WDYT?
There was a problem hiding this comment.
Oh, yes that's a much better phrasing. Thanks
|
Ok, I've pushed a few more updates. The path on windows is a bit off: it uses a mixture of |
|
Is there anything else I can do to get this past the finish line? |
In order to get GitHub annotations to show up on a PR inline in the code, the annotation path must be relative to the repository root rather than relative to the package root. For most R packages, the package root is the same as the GitHub root, but for packages that use a subdirectory (e.g. https://github.com/apache/arrow in the r/ subdirectory) the annotations don't display without adding a prefix like this.
This PR doesn't change the default case, but adds an argument to
lint_package()that allows someone to specify the correct prefix.